Skip to content

Conversation

@fingolfin
Copy link
Member

For usage instructions see https://github.com/gap-actions/release-pkg?tab=readme-ov-file#release-pkg

@cdwensley perhaps you'd be interested in using this (as successor for ReleaseTools).

@codecov
Copy link

codecov bot commented Sep 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.40%. Comparing base (3f6ba2a) to head (dfa45fa).
⚠️ Report is 10 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #84      +/-   ##
==========================================
+ Coverage   83.26%   83.40%   +0.13%     
==========================================
  Files          29       29              
  Lines        1661     1693      +32     
==========================================
+ Hits         1383     1412      +29     
- Misses        278      281       +3     

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cdwensley
Copy link
Collaborator

Yes, I would be very happy to test this out.
I've had a quick look through the instructions, nd what stood out was the instruction
"It is recommended to create a separate YAML file ..." which means absolutely nothing to me.
Perhaps if I have a look at aclib things will become clearer.
Meanwhile, is this PR ready to be merged, or is it still work in progress, as the other PR?

@cdwensley
Copy link
Collaborator

I now realise that the release.yml added here is the YAML file mentioned, and identical with that in aclib.

@cdwensley
Copy link
Collaborator

PR #81 has been merged, so when this is ready to go a release could be attempted.
Is a review needed?

@cdwensley
Copy link
Collaborator

I have now created utils/.github/workflows/release.yml.
Can this be used to make the next utils release once this PR is merged?

@cdwensley
Copy link
Collaborator

Just realised how stupid that was, so will move the file to on e or more of my other packages.

@cdwensley
Copy link
Collaborator

Am attempting a release of groupoids using this mechanism

@cdwensley
Copy link
Collaborator

Release appears to have failed with:
LaTeX Warning: Label `GroupoidInnerAutomorphism' multiply defined.
LaTeX Warning: There were multiply-defined labels.
Error: Process completed with exit code 1.
This multiply-defined label has, I think, been there for some time, and not stopped releases by the old mechanism?

@fingolfin
Copy link
Member Author

So, the idea was that you just merge this PR here and we try it out now. Anyway since you seem ok with it. I am doing that now.

Next:

This multiply-defined label has, I think, been there for some time, and not stopped releases by the old mechanism?

Indeed, we decided to become more strict because this kind of warning indicates a problem that maintainers should be aware of; previously in the CI such warnings were very easy to miss: if the CI passes / shows green, why would you look into the logs? You wouldn't, and so you'd miss the warning.

But if you declare "this is fine, let those labels be missing!" you can override this and tell it to ignore the warnings. I've done that in cubefree, see https://github.com/gap-packages/cubefree/blob/master/.github/workflows/release.yml. Relevant excerpt:

      - uses: gap-actions/build-pkg-docs@v2
        with:
          use-latex: true
          warnings-as-errors: false
          # Disable warnings as we we get errors triggered by the GAP
          # reference manual and I have no idea what causes them or how to
          # deal with them. E.g.:
          #
          #     Section: "ref:specialpcgs" already defined as: 45.13.0
          #     Now being redefined as: 45.13.2

So you can just add that warnings-as-errors: false -- though I would recommend to also add a brief comment and/or to create an issue reminding you to fix those label problems some day...

@fingolfin fingolfin merged commit 84aac85 into master Sep 10, 2025
6 checks passed
@cdwensley
Copy link
Collaborator

It was good that I was prompted to fix the Latex error, and that has now been done.
Attempting a new release by the new method there was another failure which I do not understand:
(*) Run gap-actions/release-pkg@v1
Run gap-actions/release-pkg@v1
Run gap -A -q -c 'QuitGap(ValidatePackageInfo("PackageInfo.g"));'
Run ASSETS=$RUNNER_TEMP/assets
ASSETS=/home/runner/work/_temp/assets
Run gap -A -q $GITHUB_ACTION_PATH/pkginfo_to_json.g
Error, Variable: '_GapToJsonStreamInternal' must have a value
not in any function at /home/runner/work/_actions/gap-actions/release-pkg/v1/pkginfo_to_json.g:5
Could not create package-info.json
Error: Process completed with exit code 1.

@cdwensley
Copy link
Collaborator

@fingolfin - and the same error occurs when attempting to release IBNP-0.17.

@cdwensley
Copy link
Collaborator

Have now reported these failures at: https://github.com/gap-actions/release-pkg/issues

@cdwensley
Copy link
Collaborator

... and the problem has been fixed - both groupoids and IBNP now released - Utils is next!

@fingolfin fingolfin deleted the mh/release branch October 17, 2025 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants